<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxInputData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxInputData.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classPxInputData-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxInputData Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__common.html">Common</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Input data class for I/O which provides random read access.  
 <a href="classPxInputData.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxIO_8h_source.html">PxIO.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxInputData:</div>
<div class="dyncontent">
<div class="center"><img src="classPxInputData__inherit__graph.png" border="0" usemap="#PxInputData_inherit__map" alt="Inheritance graph"/></div>
<map name="PxInputData_inherit__map" id="PxInputData_inherit__map">
<area shape="rect" id="node3" href="classPxDefaultFileInputData.html" title="default implementation of a file read stream " alt="" coords="5,155,160,181"/>
<area shape="rect" id="node4" href="classPxDefaultMemoryInputData.html" title="default implementation of a memory read stream " alt="" coords="185,155,365,181"/>
<area shape="rect" id="node2" href="classPxInputStream.html" title="Input stream class for I/O. " alt="" coords="125,5,233,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxInputData:</div>
<div class="dyncontent">
<div class="center"><img src="classPxInputData__coll__graph.png" border="0" usemap="#PxInputData_coll__map" alt="Collaboration graph"/></div>
<map name="PxInputData_coll__map" id="PxInputData_coll__map">
<area shape="rect" id="node2" href="classPxInputStream.html" title="Input stream class for I/O. " alt="" coords="5,5,113,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abab049ab736da6c5880426f3d977698b"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#abab049ab736da6c5880426f3d977698b">getLength</a> () const =0</td></tr>
<tr class="memdesc:abab049ab736da6c5880426f3d977698b"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the length of the input data  <a href="#abab049ab736da6c5880426f3d977698b">More...</a><br /></td></tr>
<tr class="separator:abab049ab736da6c5880426f3d977698b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac80d55021a6bae02a1cc64d27a98c575"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#ac80d55021a6bae02a1cc64d27a98c575">seek</a> (uint32_t offset)=0</td></tr>
<tr class="memdesc:ac80d55021a6bae02a1cc64d27a98c575"><td class="mdescLeft">&#160;</td><td class="mdescRight">seek to the given offset from the start of the data.  <a href="#ac80d55021a6bae02a1cc64d27a98c575">More...</a><br /></td></tr>
<tr class="separator:ac80d55021a6bae02a1cc64d27a98c575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ce54bcfb43ca0e9dd22bf15fcf75cab"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#a5ce54bcfb43ca0e9dd22bf15fcf75cab">tell</a> () const =0</td></tr>
<tr class="memdesc:a5ce54bcfb43ca0e9dd22bf15fcf75cab"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the current offset from the start of the data  <a href="#a5ce54bcfb43ca0e9dd22bf15fcf75cab">More...</a><br /></td></tr>
<tr class="separator:a5ce54bcfb43ca0e9dd22bf15fcf75cab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae82db2806183495ecc5b22adc3386b3a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputData.html#ae82db2806183495ecc5b22adc3386b3a">~PxInputData</a> ()</td></tr>
<tr class="separator:ae82db2806183495ecc5b22adc3386b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classPxInputStream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classPxInputStream')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classPxInputStream.html">PxInputStream</a></td></tr>
<tr class="memitem:a74fdc1e5af87577e7cc13cc99894b2b3 inherit pub_methods_classPxInputStream"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputStream.html#a74fdc1e5af87577e7cc13cc99894b2b3">read</a> (void *dest, uint32_t count)=0</td></tr>
<tr class="memdesc:a74fdc1e5af87577e7cc13cc99894b2b3 inherit pub_methods_classPxInputStream"><td class="mdescLeft">&#160;</td><td class="mdescRight">read from the stream. The number of bytes read may be less than the number requested.  <a href="classPxInputStream.html#a74fdc1e5af87577e7cc13cc99894b2b3">More...</a><br /></td></tr>
<tr class="separator:a74fdc1e5af87577e7cc13cc99894b2b3 inherit pub_methods_classPxInputStream"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9bbfe54d3bd96668f6dd19b30737e26 inherit pub_methods_classPxInputStream"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxInputStream.html#ae9bbfe54d3bd96668f6dd19b30737e26">~PxInputStream</a> ()</td></tr>
<tr class="separator:ae9bbfe54d3bd96668f6dd19b30737e26 inherit pub_methods_classPxInputStream"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Input data class for I/O which provides random read access. </p>
<p>The user needs to supply a <a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access. ">PxInputData</a> implementation to a number of methods to allow the SDK to read data. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae82db2806183495ecc5b22adc3386b3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae82db2806183495ecc5b22adc3386b3a">&#9670;&nbsp;</a></span>~PxInputData()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxInputData::~PxInputData </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abab049ab736da6c5880426f3d977698b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abab049ab736da6c5880426f3d977698b">&#9670;&nbsp;</a></span>getLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint32_t PxInputData::getLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>return the length of the input data </p>
<dl class="section return"><dt>Returns</dt><dd>size in bytes of the input data </dd></dl>

<p>Implemented in <a class="el" href="classPxDefaultFileInputData.html#a8b9e79d93cc4d7baf1b99b3e3a876e42">PxDefaultFileInputData</a>, and <a class="el" href="classPxDefaultMemoryInputData.html#a8c286611150b45e7a40005ba39faeeea">PxDefaultMemoryInputData</a>.</p>

</div>
</div>
<a id="ac80d55021a6bae02a1cc64d27a98c575"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac80d55021a6bae02a1cc64d27a98c575">&#9670;&nbsp;</a></span>seek()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxInputData::seek </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>offset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>seek to the given offset from the start of the data. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the offset to seek to. If greater than the length of the data, this call is equivalent to seek(length); </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classPxDefaultFileInputData.html#a234ab504e8d281b6e0319e40dcac7c4d">PxDefaultFileInputData</a>, and <a class="el" href="classPxDefaultMemoryInputData.html#a7344d413c8bdf97731fd63d06ba26b54">PxDefaultMemoryInputData</a>.</p>

</div>
</div>
<a id="a5ce54bcfb43ca0e9dd22bf15fcf75cab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ce54bcfb43ca0e9dd22bf15fcf75cab">&#9670;&nbsp;</a></span>tell()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual uint32_t PxInputData::tell </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>return the current offset from the start of the data </p>
<dl class="section return"><dt>Returns</dt><dd>the offset to seek to. </dd></dl>

<p>Implemented in <a class="el" href="classPxDefaultFileInputData.html#aabf6e87604951bb089885b2ae5c4a3a5">PxDefaultFileInputData</a>, and <a class="el" href="classPxDefaultMemoryInputData.html#ade8d997f98d1f6deff7311637ac140a9">PxDefaultMemoryInputData</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxIO_8h_source.html">PxIO.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxInputData.html">PxInputData</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
